Use v6 Should-* syntax in docs examples - #415
Merged
Merged
Conversation
The getting started page and usage docs taught the classic `Should -Be` syntax. v6 recommends the new `Should-*` assertions, so convert the canonical examples to them. Pages that document the old syntax on purpose are left unchanged: the classic, soft and custom assertion references, the migration guides, and the generated command reference. Some conversions are not a plain rename: - `Should -Contain` -> `Should-ContainCollection` - `Should -InvokeVerifiable` -> `Should-Invoke -Verifiable`, and the `Should -Invoke` headings lose the space (the inbound anchor in breaking-changes-in-v5 is updated to match) - quick-start failure output now shows types, e.g. `Expected 8, but got 9.` -> `Expected [int] 8, but got [int] 9.`, to match what v6 prints Verified the converted examples against Pester 6.0.0. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The getting started page and the usage docs still teach the classic
Should -Besyntax. v6 recommends the newShould-*assertions, so the canonical examples should use them.This converts the examples in
quick-startanddocs/usage/*. Pages that document the old syntax on purpose are left as they are: the classic, soft and custom assertion references, the migration guides, and the generated command reference underdocs/commands.A few conversions are not a plain rename:
Should -ContainbecomesShould-ContainCollection(membership in a collection).Should -InvokeVerifiablebecomesShould-Invoke -Verifiable, and theShould -Invokeheadings inmocking.mdxlose the space. The inbound anchor inbreaking-changes-in-v5is updated to match.quick-startnow prints types, soExpected 8, but got 9.becomesExpected [int] 8, but got [int] 9., matching what v6 actually prints.Verified the converted examples and the mappings against Pester 6.0.0.